Data - Get customer details
GET/v1/customers/:id
Get the customer details for a given customer id.
Request
Path Parameters
id stringrequired
customer uuid that needs to be considered for filter
Responses
- 200
- 401
- 404
Successful
- */*
- Schema
- Example (from schema)
Schema
Array [
]
customerUuid string
Customer UUID
email stringrequired
firstName stringrequired
lastName stringrequired
phone string
birthDate string
locale stringrequired
Possible values: Value must match regular expression ^([a-z]{2,3})(?:_([A-Z]{2}))?$
civility string
rank string
computedRank string
isVip boolean
address string
allergiesAndIntolerances string[]
dietaryRestrictions string[]
favFood string
favDrinks string
favSeating string
notes string
originRestaurantUuid string
originRestaurantName string
creationDate stringrequired
Creation date
lastUpdateDate stringrequired
Last update date
isPromoter boolean
secondaryPhone string
country string
city string
zipcode string
optins
object
required
restaurantNewsletter booleanrequired
Optin the diner to the restaurant newsletter, when false is provided it will not unsusbscribe the diner
customFields
object[]
labelUuid stringrequired
Label UUID
label stringrequired
Label value
type stringrequired
Possible values: [boolean
, string
, integer
]
value stringrequired
valueUuid string
Value UUID
{
"customerUuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"email": "john@example.com",
"firstName": "Doe",
"lastName": "John",
"phone": "string",
"birthDate": "1997-12-02",
"locale": "fr_FR",
"civility": "string",
"rank": "string",
"computedRank": "string",
"isVip": true,
"address": "string",
"allergiesAndIntolerances": [
"SEA_FOOD"
],
"dietaryRestrictions": [
"GLUTEN_FREE"
],
"favFood": "Burger",
"favDrinks": "Punk IPA",
"favSeating": "Terrace",
"notes": "string",
"originRestaurantUuid": "ddc14c13-98ce-4ece-9c82-98f84050f6f5",
"originRestaurantName": "587850fc-abd7-4486-a61a-aa05b2fbba84",
"creationDate": "2022-09-02",
"lastUpdateDate": "2022-09-30",
"isPromoter": true,
"secondaryPhone": "string",
"country": "FR",
"city": "Paris",
"zipcode": "75001",
"optins": {
"restaurantNewsletter": true
},
"customFields": [
{
"labelUuid": "55749b38-b822-4ece-b976-65a1458c6d47",
"label": "Regular lunch customer",
"type": "boolean",
"value": "string",
"valueUuid": "ada0f099-4e3d-47da-addd-1d449082fc34"
}
]
}
Unauthorized
- */*
- Schema
- Example (from schema)
Schema
data object
error string
Possible values: [Unauthorized
]
statusCode number
Possible values: [401
]
{
"data": {},
"error": "Unauthorized",
"statusCode": 401
}
Not Found
- */*
- Schema
- Example (from schema)
Schema
data
object
code string
Possible values: [CUSTOMER_NOT_FOUND
]
error string
Possible values: [Not Found
]
statusCode number
Possible values: [404
]
{
"data": {
"code": "CUSTOMER_NOT_FOUND"
},
"error": "Not Found",
"statusCode": 404
}
Loading...